Platform Explorer / Nuxeo Platform 2021.26

Operation RunFileOperation (Run File Chain)

Description

Run an operation chain which is returning a file in the current context. The input for the chain to run is a file or a list of files. Return the output of the chain as a file or a list of files. The 'parameters' injected are accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.
Operation id RunFileOperation
AliasesContext.RunFileOperation
Category Execution Flow
Label Run File Chain
Requires
Since

Parameters

Name Description Type Required Default value
id string yes  
isolate boolean no false 
newTx Define if the chain in parameter should be executed in new transaction. boolean no false 
parameters Accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}. properties no  
rollbackGlobalOnError Define if transaction should rollback or not (default to true) boolean no true 
timeout Define transaction timeout (default to 60 sec). integer no  

Signature

Inputs bloblist, blob
Outputs bloblist, blob

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.execution.RunFileChain
Contributing Component org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "RunFileOperation",
  "aliases" : [ "Context.RunFileOperation" ],
  "label" : "Run File Chain",
  "category" : "Execution Flow",
  "requires" : null,
  "description" : "Run an operation chain which is returning a file in the current context. The input for the chain to run is a file or a list of files. Return the output of the chain as a file or a list of files. The 'parameters' injected are accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.",
  "url" : "RunFileOperation",
  "signature" : [ "bloblist", "bloblist", "blob", "blob" ],
  "params" : [ {
    "name" : "id",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "isolate",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "false" ]
  }, {
    "name" : "newTx",
    "description" : "Define if the chain in parameter should be executed in new transaction.",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "false" ]
  }, {
    "name" : "parameters",
    "description" : "Accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.",
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "rollbackGlobalOnError",
    "description" : "Define if transaction should rollback or not (default to true)",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "timeout",
    "description" : "Define transaction timeout (default to 60 sec).",
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}